home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3 / X11 / XSetWMName.z / XSetWMName
Encoding:
Text File  |  1998-10-30  |  5.8 KB  |  133 lines
  1.  
  2.  
  3.  
  4.      XXXXSSSSeeeettttWWWWMMMMNNNNaaaammmmeeee((((3333XXXX11111111))))   XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....3333))))    XXXXSSSSeeeettttWWWWMMMMNNNNaaaammmmeeee((((3333XXXX11111111))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XSetWMName, XGetWMName, XStoreName, XFetchName - set or read
  10.           a window's WM_NAME property
  11.  
  12.      SSSSYYYYNNNNTTTTAAAAXXXX
  13.           void XSetWMName(_d_i_s_p_l_a_y, _w, _t_e_x_t__p_r_o_p)
  14.                 Display *_d_i_s_p_l_a_y;
  15.                 Window _w;
  16.                 XTextProperty *_t_e_x_t__p_r_o_p;
  17.  
  18.           Status XGetWMName(_d_i_s_p_l_a_y, _w, _t_e_x_t__p_r_o_p__r_e_t_u_r_n)
  19.                 Display *_d_i_s_p_l_a_y;
  20.                 Window _w;
  21.                 XTextProperty *_t_e_x_t__p_r_o_p__r_e_t_u_r_n;
  22.  
  23.           XStoreName(_d_i_s_p_l_a_y, _w, _w_i_n_d_o_w__n_a_m_e)
  24.                 Display *_d_i_s_p_l_a_y;
  25.                 Window _w;
  26.                 char *_w_i_n_d_o_w__n_a_m_e;
  27.  
  28.           Status XFetchName(_d_i_s_p_l_a_y, _w, _w_i_n_d_o_w__n_a_m_e__r_e_t_u_r_n)
  29.                 Display *_d_i_s_p_l_a_y;
  30.                 Window _w;
  31.                 char **_w_i_n_d_o_w__n_a_m_e__r_e_t_u_r_n;
  32.  
  33.      AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  34.           _d_i_s_p_l_a_y   Specifies the connection to the X server.
  35.  
  36.           _t_e_x_t__p_r_o_p Specifies the _X_T_e_x_t_P_r_o_p_e_r_t_y structure to be used.
  37.  
  38.           _t_e_x_t__p_r_o_p__r_e_t_u_r_n
  39.                     Returns the _X_T_e_x_t_P_r_o_p_e_r_t_y structure.
  40.  
  41.           _w         Specifies the window.
  42.  
  43.           _w_i_n_d_o_w__n_a_m_e
  44.                     Specifies the window name, which should be a
  45.                     null-terminated string.
  46.  
  47.           _w_i_n_d_o_w__n_a_m_e__r_e_t_u_r_n
  48.                     Returns the window name, which is a null-
  49.                     terminated string.
  50.  
  51.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  52.           The _X_S_e_t_W_M_N_a_m_e convenience function calls _X_S_e_t_T_e_x_t_P_r_o_p_e_r_t_y
  53.           to set the WM_NAME property.
  54.  
  55.           The _X_G_e_t_W_M_N_a_m_e convenience function calls _X_G_e_t_T_e_x_t_P_r_o_p_e_r_t_y
  56.           to obtain the WM_NAME property.  It returns a nonzero status
  57.           on success; otherwise, it returns a zero status.
  58.  
  59.           The _X_S_t_o_r_e_N_a_m_e function assigns the name passed to
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 4/30/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXSSSSeeeettttWWWWMMMMNNNNaaaammmmeeee((((3333XXXX11111111))))   XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....3333))))    XXXXSSSSeeeettttWWWWMMMMNNNNaaaammmmeeee((((3333XXXX11111111))))
  71.  
  72.  
  73.  
  74.           window_name to the specified window.  A window manager can
  75.           display the window name in some prominent place, such as the
  76.           title bar, to allow users to identify windows easily.  Some
  77.           window managers may display a window's name in the window's
  78.           icon, although they are encouraged to use the window's icon
  79.           name if one is provided by the application.  If the string
  80.           is not in the Host Portable Character Encoding, the result
  81.           is implementation-dependent.
  82.  
  83.           _X_S_t_o_r_e_N_a_m_e can generate _B_a_d_A_l_l_o_c and _B_a_d_W_i_n_d_o_w errors.
  84.  
  85.           The _X_F_e_t_c_h_N_a_m_e function returns the name of the specified
  86.           window.  If it succeeds, it returns a nonzero status;
  87.           otherwise, no name has been set for the window, and it
  88.           returns zero.  If the WM_NAME property has not been set for
  89.           this window, _X_F_e_t_c_h_N_a_m_e sets window_name_return to NULL.  If
  90.           the data returned by the server is in the Latin Portable
  91.           Character Encoding, then the returned string is in the Host
  92.           Portable Character Encoding.  Otherwise, the result is
  93.           implementation-dependent.  When finished with it, a client
  94.           must free the window name string using _X_F_r_e_e.
  95.  
  96.           _X_F_e_t_c_h_N_a_m_e can generate a _B_a_d_W_i_n_d_o_w error.
  97.  
  98.      PPPPRRRROOOOPPPPEEEERRRRTTTTIIIIEEEESSSS
  99.           WM_NAME   The name of the application.
  100.  
  101.      DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  102.           _B_a_d_A_l_l_o_c  The server failed to allocate the requested
  103.                     resource or server memory.
  104.  
  105.           _B_a_d_W_i_n_d_o_w A value for a Window argument does not name a
  106.                     defined Window.
  107.  
  108.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  109.           XAllocClassHint(3X11), XAllocIconSize(3X11),
  110.           XAllocSizeHints(3X11), XAllocWMHints(3X11), XFree(3X11),
  111.           XSetCommand(3X11), XSetTransientForHint(3X11),
  112.           XSetTextProperty(3X11), XSetWMClientMachine(3X11),
  113.           XSetWMColormapWindows(3X11), XSetWMIconName(3X11),
  114.           XSetWMProperties(3X11), XSetWMProtocols(3X11),
  115.           XStringListToTextProperty(3X11)
  116.           _X_l_i_b - _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 4/30/98)
  130.  
  131.  
  132.  
  133.